Download OpenAPI specification:Download
The EF-45 REST API methods allow developers to access core EF-45 functionality such as device connection, camera control, user enrollment, biometric recognition, and event logs collection. The EF-45 works as the server that receives a request from the client and attempts to fulfill the request and send the client back a response. The API uses RESTful protocol and responses are in JSON format.
| lock_uid required | string Format: 8-4-4-4-12 |
Current camera settings
After successful operation,'delete preview' will be invoked
| lock_uid required | string Format: 8-4-4-4-12 |
Camera setting update results
| device_time required | string The time format is 'MMddhhmmyyy.ss'. For example, '052014402018.30' means 'May 20th, 2018, 2:20:30 PM'. |
| lock_uid required | string |
Camera setting update results
[Important] Make sure that the camera mode is set to 'Slave' before starting camera. [Note] • Before request: Retrieve data list by using biometric-data(GET) -> Delete data list by using biometric-data(DELETE) • After successful response: Start restBiomericDataPolling()
| lock_uid required | string Format: 8-4-4-4-12 |
| face_mode | boolean At least one biometric mode(both eye, either eye, face w/ glasses, face wo/ glasses) is requried as a query parameter. |
| glasses_mode | boolean At least one biometric mode(both eye, either eye, face w/ glasses, face wo/ glasses) is requried as a query parameter. |
| both_eye_mode | boolean At least one biometric mode(both eye, either eye, face w/ glasses, face wo/ glasses) is requried as a query parameter. |
| either_eye_mode | boolean At least one biometric mode(both eye, either eye, face w/ glasses, face wo/ glasses) is requried as a query parameter. |
| streaming_mode | boolean Start camera to get face at full resolution |
| recog_mode | string • If recog_mode is set to false(default), camera settings on enrollment will be applied. • If recog_mode is set to true, camera settings on recognition will be applied to make capture faster than enrollment mode. |
Camera start results
After successful response, restBiomericDataPolling() will stop. Camera will stop automatically when capture and data transmission are completed. Or you can force camera to stop when there is no activity for a period of time.
| lock_uid required | string Format: 8-4-4-4-12 |
Camera stop results
The API is designed to provide matching simulation between the iris template read from the card reader and the iris template from EF-45 database.
| seq_uid required | string Format: 8-4-4-4-12 |
| lock_uid required | string Format: 8-4-4-4-12 |
Camera start for match template results
• Original endpoint supported up to App. version 1.2.33 • Keep polling to check and retrieve biometric data on enrollment mode • Data size: about 5MB
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved biometric data information
• Revised endpoint supported since App. version 1.2.34 • Keep polling to check and retrieve biometric data on enrollment mode • Data size: about 5MB
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved biometric data information
Delete buffer right after receiving biometric data
| encounter_id required | string encounter_id can be found in response message for biometric data query
|
| lock_uid required | string Format: 8-4-4-4-12 |
Save for Black & White 8bit Iris image
| lock_uid required | string Format: 8-4-4-4-12 |
left eye image = "lefteye.bmp" right eye image = "righteye.bmp"
Results for save image request
Save for color 24bit face image
| lock_uid required | string Format: 8-4-4-4-12 |
Face image when capturing iris = "irisoff.bmp" Color face image when capturing face = "faroff.bmp" B/W face image when capturing face = "faron.bmp" Color face image with glasses when capturing face = "nearoff.bmp" B/W face image with glasses when capturing face = "nearon.bmp"
Results for save image request
Load various images
| lock_uid required | string Format: 8-4-4-4-12 |
| filename required | string
|
Loaded image data and information
Save various images
| lock_uid required | string Format: 8-4-4-4-12 |
| filename required | string
|
base64 encoded
• View all: http://{host}/1.0/subjects?lock_uid={lock_uid} • View per page(default): http://{host}/1.0/subjects?lock_uid={lock_uid}&page={page} • View per page(size): http://{host}/1.0/subjects?lock_uid={lock_uid}&page={page}&page_size={page_size}
| lock_uid required | string Format: 8-4-4-4-12 |
| page | integer <int32> • Number of pages to view • Without the parameter, all the list will appear |
| page_size | integer <int32> • Number of rows in a single page view(default: 50 rows) • Without the parameter, default number of rows will be applied in a page |
Retrieved subject list
Subject data table(subject, userinfo, face, …) order is irrelevant
| lock_uid required | string Format: 8-4-4-4-12 |
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved a subject
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
| lock_uid required | string Format: 8-4-4-4-12 |
Duplication check result
Record version represents the device's built-in biometric(iris, face) algorithm type and version. The value(ex. 8976) is fixed and not subject to change unless the algorithm is changed.
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved a subject
• View all: http://{host}/1.0/user-info?lock_uid={lock_uid} • View per page(default): http://{host}/1.0/user-info?lock_uid={lock_uid}&page={page} • View per page(size): http://{host}/1.0/user-info?lock_uid={lock_uid}&page={page}&page_size={page_size}
| lock_uid required | string Format: 8-4-4-4-12 |
| page | integer <int32> • Number of pages to view • Without the parameter, all the list will appear |
| page_size | integer <int32> • Number of rows in a single page view(default: 50 rows) • Without the parameter, default number of rows will be applied in a page |
Retrieved user list
| card required | string Expressed in HEX(with space inserted per 2 bytes) ex) '65 D8 A1 BD' |
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved user info by card
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved user info by uuid
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
Default response
• URL Example: http://192.168.0.100:9980/1.0/user?lock_uid=13dbb896-ed1e-11e6-9822-503f98000109 • Body Example:{"user_uuid":"1","record_version":0,"last_name":"abc", ... , "faces":[{"sub_id":1,"face_eye_width": ... }], ...}
| lock_uid required | string Format: 8-4-4-4-12 |
• View all: http://{host}/1.0/faces?lock_uid={lock_uid} • View per page(default): http://{host}/1.0/faces?lock_uid={lock_uid}&page={page} • View per page(size): http://{host}/1.0/faces?lock_uid={lock_uid}&page={page}&page_size={page_size}
| lock_uid required | string Format: 8-4-4-4-12 |
| page | integer <int32> • Number of pages to view • Without the parameter, all the list will appear |
| page_size | integer <int32> • Number of rows in a single page view(default: 50 rows) • Without the parameter, default number of rows will be applied in a page |
Retrieved face list
http://{host}/1.0/faces/{user_uuid}?lock_uid={lock_uid} http://{host}/1.0/faces/{user_uuid}?lock_uid={lock_uid}&subId={sub_id}
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
| subId | integer <int32> When you will get face info by sub id, add this query parameter. 0: color face 1: B/W face 2: color glasses 3: B/W glasses 4: color updated 5: B/W updated |
Retrieved user's face info
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
| sub_id required | integer <int32> |
One face info deleted at a time • URL Example: http://192.168.0.218:9980/1.0/faces/111?lock_uid=af7f8dba-625f-11e8-bdec-503f98000288&subId=1
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
| subId required | integer <int32> |
| title required | string |
| type required | string ex) bool, float, int, string |
| lock_uid required | string Format: 8-4-4-4-12 |
Queried device setting
| title required | string |
| type required | string ex) bool, float, int, string |
| lock_uid required | string Format: 8-4-4-4-12 |
Use polling to get the status continually
| lock_uid required | string Format: 8-4-4-4-12 |
Queried door status
Keep polling to check if there is matching event and matched data in the device
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved match data
Emptying buffer after getting matched data
| encounter_id required | string encounter_id can be found in response message for match data query
|
| lock_uid required | string Format: 8-4-4-4-12 |
• View logs per page(default): http://{host}/1.0/logs?lock_uid={lock_uid}&page={page} • View recent logs: http://{host}/1.0/logs?lock_uid={lock_uid}&page=1&page_size={page_size}&order=desc
| lock_uid required | string Format: 8-4-4-4-12 |
| page | integer <int32> • Number of pages to view • Without the parameter, all the list will appear |
| page_size | integer <int32> • Number of rows in a single page view(default: 50 rows) • Without the parameter, default number of rows will be applied in a page |
Retrieved log list • Response example: {"status_code":200,"reason_phrase":"OK","items":[{"id":68,"event_type":"Recognition","timestamp":"2018-05-28T14:26:26Z","user_uuid":"111","info":"Recog/BioOnly/IrisOk","additional_data":"Allowed","matched_faceimage_data":""},{"id":69,"event_type":"UserData","timestamp":"2018-05-28T14:45:57Z","user_uuid":"111","info":"DeleteUsers","additional_data":"Success","matched_faceimage_data":""},...],"page":1,"page_size":50,"has_more":false,"total":7}
URL: http://{host}/1.0/logs?lock_uid={lock_uid}&min={from_id}&max={to_id}
| lock_uid required | string Format: 8-4-4-4-12 |
| from_id required | integer <int32> start log ID |
| to_id required | integer <int32> end log ID |
• View logs per page(from-to): http://{host}/1.0/logs/from/to?lock_uid={lock_uid}&page={page}&min={from_id}&max={to_id} • URL Example: http://192.168.0.218:9980/1.0/logs/from/to?lock_uid=6c45cc76-6291-11e8-b384-503f98000288&page=1&min=68&max=74
| lock_uid required | string Format: 8-4-4-4-12 |
| page | integer <int32> • Number of pages to view • Without the parameter, all the list will appear |
| page_size | integer <int32> • Number of rows in a single page view(default: 50 rows) • Without the parameter, default number of rows will be applied in a page |
| from_id required | integer <int32> start log ID |
| to_id required | integer <int32> end log ID |
Retrieved log list
| id required | integer <int32> log ID |
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved log list
Start showing live preview image on the host PC application after camera start and keep polling until the capture is completed.
| lock_uid required | string Format: 8-4-4-4-12 |
Retrieved log list
When requested, the previous incomplete firmware data transmission will be aborted and the firmware data will be deleted.
| lock_uid required | string Format: 8-4-4-4-12 |
When requested, the previous incomplete firmware data transmission will be aborted and the firmware data will be deleted.
| lock_uid required | string Format: 8-4-4-4-12 |
While running the loop for data transmission, the splitted firmware data units of pre-definded upload buffer size(about 1MB in total per each unit) which is encoded with Base64 will be sent to to device in order except the last data unit.
| lock_uid required | string Format: 8-4-4-4-12 |
While running the loop for data transmission, the splitted firmware data units of pre-definded upload buffer size(about 1MB in total per each unit) which is encoded with Base64 will be sent to to device in order except the last data unit.
| lock_uid required | string Format: 8-4-4-4-12 |
• On this request, the last firmware data unit will be transferred and file transmission results will be returned. • If the firmware upload is successful, the device will start firmware upgrade process by itself after checking firmware version. • When the first stage is completed, the device will reboot automatically and follow the firmware upgrade routine after reboot. Make sure that the device will not turn off the device during this time. • If the device turn off during the firmware upgrade, it will usually revert to the previous firmware through recovery mode. If the device is not recovered by recovery mode, RMA is required in this case. • When the firmware upgrade is completed, the device will reboot and the main screen will appear.
| lock_uid required | string Format: 8-4-4-4-12 |
Firmware upgrade result
• On this request, the last firmware data unit will be transferred and file transmission results will be returned. • If the firmware upload is successful, the device will start firmware upgrade process by itself after checking firmware version. • When the first stage is completed, the device will reboot automatically and follow the firmware upgrade routine after reboot. Make sure that the device will not turn off the device during this time. • If the device turn off during the firmware upgrade, it will usually revert to the previous firmware through recovery mode. If the device is not recovered by recovery mode, RMA is required in this case. • When the firmware upgrade is completed, the device will reboot and the main screen will appear.
| lock_uid required | string Format: 8-4-4-4-12 |
Firmware upgrade result
• To use this API correctly, 'Use manual command'(Settings > Network > Server) in the device settings menu needs to be enabled first. • At lease one parameter should be included in the request body.
| lock_uid required | string Format: 8-4-4-4-12 |
Device conrol results
• The camera mode should be set to 'Slave'(Enroll mode) first. • When started, the device will show card input screen for card tagging or manual input
| lock_uid required | string Format: 8-4-4-4-12 |
Setting APBStatus to 1(CLEAR) will force the user to be released from anti-passback violation status and let him or her to access again.
| user_uuid required | string |
| lock_uid required | string Format: 8-4-4-4-12 |
Setting APBStatus to 1(CLEAR) will force all the user to be released from anti-passback violation status and let them to access again.
| lock_uid required | string Format: 8-4-4-4-12 |